package com.nosnow.common.utils;

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.util.HashMap;
import java.util.Map;

/**
 * @author by bingHeng
 * @version 1.0
 * @Create 2020/3/29 22:09
 *
 * 定义统一返回结果的类
 */
@Data
public class R {

    /**
     * 统一返回数据格式：
     * 项目中我们会将响应封装成json返回，一般我们会将所有接口的数据格式统一，使前端（IOS、Android、Web等）对数据的操作更一致轻松。
     *
     * 一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以了，但是一般会包含状态码、返回信息、数据这几部分内容。
     */

    // 私有化构造器
    private R(){}

    @ApiModelProperty(value = "是否成功")
    private Boolean success;

    @ApiModelProperty(value = "返回码")
    private Integer code;

    @ApiModelProperty(value = "返回消息")
    private String message;

    @ApiModelProperty(value = "返回数据")
    private Map<String, Object> data = new HashMap<>(16);

    // 成功的静态方法
    public static R ok() {
        R r = new R();
        r.setSuccess(true);
        r.setCode(ResultCode.SUCCESS);
        r.setMessage("获取数据成功");
        return r;
    }

    // 失败的静态方法
    public static R error() {
        R r = new R();
        r.setSuccess(false);
        r.setCode(ResultCode.ERROR);
        r.setMessage("获取数据失败");
        return r;
    }

    // 之所以返回this（R对象），是因为想使用链式编程
    public R success(Boolean success) {
        this.setSuccess(success);
        return this;
    }

    public R message(String message) {
        this.setMessage(message);
        return this;
    }

    public R code(Integer code) {
        this.setCode(code);
        return this;
    }

    public R data(String key, Object value) {
        this.data.put(key, value);
        return this;
    }

    public R data(Map<String, Object> map) {
        this.setData(map);
        return this;
    }
}
